shared-domain-ux

(0 reviews)

TMF 632 - List Organizations

Retrieve a collection of organizations according to the given criteria. The request can be made using either of the parameters i.e. id (groupId), BillingAccountNumber(Ban-Can) or MSISDN. Only one of them is required.

URL

https://[localhost]:[port]/shared-domain-ux/tmf-api/partyManagement/v1/{businessId}/organization

url Param

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	Y

name	type	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y

Query Param

name	type	description	required
organizationType	string	Type of organization (example - Multiline)	N
id	string	Organization id (groupId)	N
relatedParty.partyCharacteristic.name	string	Name of the relatedParty characteristic to filter by (example - bancan, msisdn)	N
relatedParty.partyCharacteristic.value	string	Value of the partyCharacteristic defined in name	N
expand	string	Expands the related attributes in the response (example - relatedParty)	N

If more than one query parameter is provided, the lookup priority at end system is:

id
msisdn
billingAccount(bancan)

Request to fetch the list of organizations:

Query with ID

curl --location 'https://nonprod.{bgid}.esb.cloud.lla.com/test/shared-domain-ux-{bgid}/tmf-api/partyManagement/v1/{businessId}/organization?organizationType=Multiline&id=14282805684&expand=relatedParty' \
--header 'client_id: xxxxxxxxx' \
--header 'client_secret: xxxxxxxxxxx' \
--header 'X-Correlation-ID: {{$guid}}'

Query with Billing account

curl --location 'https://nonprod.{bgid}.esb.cloud.lla.com/test/shared-domain-ux-{bgid}/tmf-api/partyManagement/v1/{businessId}/organization?organizationType=Multiline&relatedParty.partyCharacteristic.name=bancan&relatedParty.partyCharacteristic.value=BAN-1234&expand=relatedParty
' \
--header 'client_id: xxxxxxxxx' \
--header 'client_secret: xxxxxxxxxxx' \
--header 'X-Correlation-ID: {{$guid}}'

Query with MSISDN

curl --location 'https://nonprod.{bgid}.esb.cloud.lla.com/test/shared-domain-ux-{bgid}/tmf-api/partyManagement/v1/{businessId}/organization?organizationType=Multiline&
relatedParty.partyCharacteristic.name=msisdn&relatedParty.partyCharacteristic.value=17802805684&expand=relatedParty' \
--header 'client_id: xxxxxxxxx' \
--header 'client_secret: xxxxxxxxxxx' \
--header 'X-Correlation-ID: {{$guid}}'

Response

[
  {
    "existsDuring": {
      "startDateTime": "2026-09-01T00:00:00.000-05:00"
    },
    "id": "14282805684",
    "isLegalEntity": false,
    "organizationType": "Multiline",
    "partyCharacteristic": [
      {
        "name": "membersNumber",
        "value": 3,
        "valueType": "integer"
      },
      {
        "name": "autopay",
        "value": true,
        "valueType": "boolean"
      },
      {
        "name": "groupPin",
        "value": "4821",
        "valueType": "string"
      }
    ],
    "relatedParty": [
      {
        "@referredType": "Individual",
        "id": "01",
        "partyCharacteristic": [
          {
            "name": "MSISDN",
            "value": "17802805684",
            "valueType": "string"
          },
          {
            "name": "addedDate",
            "value": "2026-09-01T00:00:00.000-05:00",
            "valueType": "datetime"
          },
          {
            "name": "autopayOwner",
            "value": false,
            "valueType": "boolean"
          }
        ],
        "role": "Owner"
      },
      {
        "@referredType": "Individual",
        "id": "02",
        "partyCharacteristic": [
          {
            "name": "MSISDN",
            "value": "17875551234",
            "valueType": "string"
          },
          {
            "name": "addedDate",
            "value": "2026-09-01T00:00:00.000-05:00",
            "valueType": "datetime"
          },
          {
            "name": "autopayOwner",
            "value": true,
            "valueType": "boolean"
          }
        ],
        "role": "Member"
      },
      {
        "@referredType": "Individual",
        "id": "03",
        "partyCharacteristic": [
          {
            "name": "MSISDN",
            "value": "17875559876",
            "valueType": "string"
          },
          {
            "name": "addedDate",
            "value": "2026-09-15T00:00:00.000-05:00",
            "valueType": "datetime"
          },
          {
            "name": "autopayOwner",
            "value": false,
            "valueType": "boolean"
          }
        ],
        "role": "Member"
      }
    ],
    "status": "Active"
  }
]

Definitions

Each of the response parameters is detailed.

name	type	description
existsDuring.startDateTime	datetime	group start date`
id	string	Discount Group identifier.
isLegalEntity	string	If value is true, the organization is a legal entity known by a national referential.
organizationType	string	type of the group example `Multiline`
partyCharacteristic[membersNumber].value	integer	number of members in the group
partyCharacteristic[autopay].value	boolean	indicates if autopay is enabled for the group.
partyCharacteristic[groupPin].value	string	4 digit group PIN / password set by the Group Owner.
relatedParty[].'@referredType'	string	Static Value. `Individual`
relatedParty[].id	string	Id for relatedParty entity
relatedParty[].partyCharacteristic[MSISDN].value	string	Value of MSISDN
relatedParty[].partyCharacteristic[addedDate].value	datetime	Date the member was added to the group
relatedParty[].partyCharacteristic[autopayOwner].value	boolean	Indicates the member whose payment method funds the group autopay.
relatedParty[].role	string	Role of the Individual in the group
status	string	Status of the group

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource."
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The server could not find the requested resource.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method PATCH not allowed for : /{businessId}/organization"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Server Error",
      "description": "The request failed due to an internal error."
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation GET /{businessId}/organization for Business Id: xxxx not implemented"
    }]
  }

#####